﻿<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>GetDirList</title>
<meta http-equiv="Content-Type" Content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../styles/styles.css">
<script language="javascript" src='../links.js' type="text/javascript"></script>
</head>
<body>

<h1>GetDirList</h1>
<div class=navbar>
<a href="../index.html">главная</a> |
<a href="index.html">сервисные функции</a> |
<a href="../panelapi/index.html">Panel API</a>
</div>

<div class=shortdescr>
Функция <code>GetDirList</code> возвращает список файлов в указанной директории (с поддиректориями).
</div>

<pre class=syntax>
intptr_t WINAPI GetDirList(
  const wchar_t *Dir,
  struct PluginPanelItem **pPanelItem,
  size_t *pItemsNumber
);
</pre>

<h3>Параметры</h3>
<div class=descr>
  <div class=dfn>Dir</div>
    <div class=dfndescr>Имя обрабатываемого подкаталога текущего каталога. Может быть как именем без пути, так и с полным путём.</div>
  <div class=dfn>pPanelItem</div>
    <div class=dfndescr>Указывает на переменную, которая получит адрес массива структур <a href="../structures/pluginpanelitem.html">PluginPanelItem</a>.<br>
    Когда этот массив больше не нужен, он должен быть передан функции <a href="freedirlist.html">FreeDirList</a>.</div>
  <div class=dfn>pItemsNumber</div>
    <div class=dfndescr>Указывает на переменную, которая получит число структур <a href="../structures/pluginpanelitem.html">PluginPanelItem</a>.</div>
</div>

<h3>Возвращаемое значение</h3>
<div class=descr>
Если функция завершилась успешно, она вернёт <code>TRUE</code>. Если функция закончилась неудачно или обработка директории была прервана пользователем, то она вернёт <code>FALSE</code>.
</div>

<h3>Замечания</h3>
<div class=descr>
<ol>
<li>Функция возвращает полные пути к файлам. Например, если <code>Dir</code> есть <code>D:\DIR1\DIR2</code>, то имена файлов будут в виде <code>D:\DIR1\DIR2\file.ext</code>, <code>D:\DIR1\DIR2\subdir\file.ext</code> и т.п.
<li>Пользователь может прервать выполнение функции, нажав клавишу <kbd>Esc</kbd>, при этом функция вернёт значение <code>FALSE</code>.
</ol>
</div>

<div class=see>Смотрите также:</div>
<div class=seecont>
<a href="getplugindirlist.html">GetPluginDirList</a>
</div>

</body>
</html>